/*****************************************************************************/
/*                                                                           */
/*                                  input.h                                  */
/*                                                                           */
/*                            Input file handling                            */
/*                                                                           */
/*                                                                           */
/*                                                                           */
/* (C) 2000-2010, Ullrich von Bassewitz                                      */
/*                Roemerstrasse 52                                           */
/*                D-70794 Filderstadt                                        */
/* EMail:         uz@cc65.org                                                */
/*                                                                           */
/*                                                                           */
/* This software is provided 'as-is', without any expressed or implied       */
/* warranty.  In no event will the authors be held liable for any damages    */
/* arising from the use of this software.                                    */
/*                                                                           */
/* Permission is granted to anyone to use this software for any purpose,     */
/* including commercial applications, and to alter it and redistribute it    */
/* freely, subject to the following restrictions:                            */
/*                                                                           */
/* 1. The origin of this software must not be misrepresented; you must not   */
/*    claim that you wrote the original software. If you use this software   */
/*    in a product, an acknowledgment in the product documentation would be  */
/*    appreciated but is not required.                                       */
/* 2. Altered source versions must be plainly marked as such, and must not   */
/*    be misrepresented as being the original software.                      */
/* 3. This notice may not be removed or altered from any source              */
/*    distribution.                                                          */
/*                                                                           */
/*****************************************************************************/

#ifndef INPUT_H
#define INPUT_H

#include <stdio.h>

/* common */
#include "strbuf.h"

/*****************************************************************************/
/*                                   data                                    */
/*****************************************************************************/

/* An enum that describes different types of input files. The members are
** choosen so that it is possible to combine them to bitsets
*/
typedef enum {
  IT_MAIN = 0x01,   /* Main input file */
  IT_SYSINC = 0x02, /* System include file (using <>) */
  IT_USRINC = 0x04, /* User include file (using "") */
} InputType;

/* Struct that describes an input file */
typedef struct IFile IFile;
struct IFile {
  unsigned Index;      /* File index */
  unsigned Usage;      /* Usage counter */
  unsigned long Size;  /* File size */
  unsigned long MTime; /* Time of last modification */
  InputType Type;      /* Type of input file */
  char Name[1];        /* Name of file (dynamically allocated) */
};

/* The current input line */
extern StrBuf *Line;

/* Current and next input character */
extern char CurC;
extern char NextC;

/*****************************************************************************/
/*                                   Code                                    */
/*****************************************************************************/

void OpenMainFile(const char *Name);
/* Open the main file. Will call Fatal() in case of failures. */

void OpenIncludeFile(const char *Name, InputType IT);
/* Open an include file and insert it into the tables. */

void NextChar(void);
/* Read the next character from the input stream and make CurC and NextC
** valid. If end of line is reached, both are set to NUL, no more lines
** are read by this function.
*/

void ClearLine(void);
/* Clear the current input line */

StrBuf *InitLine(StrBuf *Buf);
/* Initialize Line from Buf and read CurC and NextC from the new input line.
** The function returns the old input line.
*/

int NextLine(void);
/* Get a line from the current input. Returns 0 on end of file. */

const char *GetInputFile(const struct IFile *IF);
/* Return a filename from an IFile struct */

const char *GetCurrentFile(void);
/* Return the name of the current input file */

unsigned GetCurrentLine(void);
/* Return the line number in the current input file */

void CreateDependencies(void);
/* Create dependency files requested by the user */

const char *GetLine(const struct IFile *IF, unsigned line);

/* End of input.h */

#endif
